Skip to content

feat(reporter): Markdown report generator + package config#40

Merged
sepehr-safari merged 1 commit into
mainfrom
feat/reporter-package
Jul 7, 2026
Merged

feat(reporter): Markdown report generator + package config#40
sepehr-safari merged 1 commit into
mainfrom
feat/reporter-package

Conversation

@sepehr-safari

Copy link
Copy Markdown
Member

Summary

Creates the @ocpp-debugkit/reporter package with a Markdown report generator.

Closes #24

Changes

New package: packages/reporter/

  • src/markdown.tsgenerateMarkdownReport() producing:
    • Session overview (station, connector, transaction, start/end, duration, status)
    • Timeline summary (event count, duration, action sequence)
    • Failures (severity emoji, description, event IDs, suggested steps)
    • Suggested next steps (aggregated from all failures)
    • Raw event appendix (compact table)
    • Parse warnings (if any)
  • src/types.tsAnalysisResult input type
  • src/markdown.test.ts — 11 tests
  • package.json — publish-ready

Verification

  • pnpm lint — ✅
  • pnpm typecheck — ✅
  • pnpm test — ✅ (179 tests)
  • pnpm build — ✅
  • pnpm format:check — ✅

- generateMarkdownReport() produces a structured Markdown report with:
  session overview, timeline summary, failures (with severity and suggested
  steps), suggested next steps, and raw event appendix
- AnalysisResult input type representing the analysis pipeline output
- 11 tests covering structure, failure inclusion, readability, metadata, severity

Closes #24
@sepehr-safari sepehr-safari added this to the v0.1.0 — Inspector MVP milestone Jul 7, 2026
@sepehr-safari sepehr-safari added type:feature New feature or enhancement package:reporter @ocpp-debugkit/reporter labels Jul 7, 2026
@sepehr-safari sepehr-safari merged commit 805434f into main Jul 7, 2026
1 check passed
@sepehr-safari sepehr-safari deleted the feat/reporter-package branch July 7, 2026 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

package:reporter @ocpp-debugkit/reporter type:feature New feature or enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(reporter): Markdown report generator + package config

1 participant